/*
 * This file Copyright (c) 2015. Walle.
 * (http://www.wallellen.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the
 * Walle Agreement (WA) and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or WA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Walle Agreement (WA), this file
 * and the accompanying materials are made available under the
 * terms of the WA which accompanies this distribution, and
 * is available at http://www.wallellen.com/agreement.html
 *
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 */

package com.wallellen.lucene.common;

import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.Sort;

/**
 * 全文检索语法分析器（WHERE(sdf,dfd=sdfsfd)ORDER_BY(dddd ASC)）
 */
public interface IqlAnalyseInter {
    // "查询字段", "查询词",记录数

    /**
     * 获得要搜索的字段
     *
     * @return
     */
    public String[] getLimitTitle();

    /**
     * 获得要搜索的字段值
     *
     * @return
     */
    public String getLimitValue();

    /**
     * 获得排序规则
     *
     * @return
     */
    public Sort getSortTitle();

    /**
     * 最大要查到的记录数
     *
     * @return
     */
    public int getMaxTopNum();

    /**
     * 获得所要的分页结果
     *
     * @param allDoc 查到的全部结果
     * @return
     */
    public ScoreDoc[] subDoc(ScoreDoc[] allDoc);

    /**
     * 获得IQL
     *
     * @return
     */
    public String getIQL();
}
